<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package org.hackystat.telemetry.analyzer.configuration;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    import java.util.Collection;<a name="line.3"></a>
<FONT color="green">004</FONT>    import java.util.List;<a name="line.4"></a>
<FONT color="green">005</FONT>    <a name="line.5"></a>
<FONT color="green">006</FONT>    import org.hackystat.sensorbase.resource.users.jaxb.User;<a name="line.6"></a>
<FONT color="green">007</FONT>    import org.hackystat.telemetry.analyzer.configuration.jaxb.TelemetryDefinition;<a name="line.7"></a>
<FONT color="green">008</FONT>    <a name="line.8"></a>
<FONT color="green">009</FONT>    /**<a name="line.9"></a>
<FONT color="green">010</FONT>     * Provides the base class associated with the persistent and non-persistent<a name="line.10"></a>
<FONT color="green">011</FONT>     * Telemetry definition managers.<a name="line.11"></a>
<FONT color="green">012</FONT>     * <a name="line.12"></a>
<FONT color="green">013</FONT>     * @author (Cedric) Qin Zhang<a name="line.13"></a>
<FONT color="green">014</FONT>     */<a name="line.14"></a>
<FONT color="green">015</FONT>    public abstract class TelemetryDefinitionManager {<a name="line.15"></a>
<FONT color="green">016</FONT>      <a name="line.16"></a>
<FONT color="green">017</FONT>      /**<a name="line.17"></a>
<FONT color="green">018</FONT>       * Gets the telemetry definition information by name.<a name="line.18"></a>
<FONT color="green">019</FONT>       * <a name="line.19"></a>
<FONT color="green">020</FONT>       * @param owner The owner under which to find the telemetry definition object.<a name="line.20"></a>
<FONT color="green">021</FONT>       * @param name The name of the telemetry definition.<a name="line.21"></a>
<FONT color="green">022</FONT>       * @param includeShared If true, then those telemetry definitions owned by other users, <a name="line.22"></a>
<FONT color="green">023</FONT>       *        but is shared will also be returned.<a name="line.23"></a>
<FONT color="green">024</FONT>       * @param type The definition type.<a name="line.24"></a>
<FONT color="green">025</FONT>       * <a name="line.25"></a>
<FONT color="green">026</FONT>       * @return The object if found, or null.<a name="line.26"></a>
<FONT color="green">027</FONT>       */<a name="line.27"></a>
<FONT color="green">028</FONT>      public abstract TelemetryDefinitionInfo get(<a name="line.28"></a>
<FONT color="green">029</FONT>          User owner, String name, boolean includeShared, TelemetryDefinitionType type);<a name="line.29"></a>
<FONT color="green">030</FONT>      <a name="line.30"></a>
<FONT color="green">031</FONT>      /**<a name="line.31"></a>
<FONT color="green">032</FONT>       * Gets all telemetry definitions that this user has access to.<a name="line.32"></a>
<FONT color="green">033</FONT>       * <a name="line.33"></a>
<FONT color="green">034</FONT>       * @param owner The owner of the telemetry definitions returned.<a name="line.34"></a>
<FONT color="green">035</FONT>       * @param includeShared If true, then those telemetry definitions owned by<a name="line.35"></a>
<FONT color="green">036</FONT>       *        other users, but is shared will also be returned.<a name="line.36"></a>
<FONT color="green">037</FONT>       * @param type The definition type.<a name="line.37"></a>
<FONT color="green">038</FONT>       *       <a name="line.38"></a>
<FONT color="green">039</FONT>       * @return A collection of found objects.<a name="line.39"></a>
<FONT color="green">040</FONT>       */<a name="line.40"></a>
<FONT color="green">041</FONT>      public abstract Collection&lt;TelemetryDefinitionInfo&gt; getAll(User owner, boolean includeShared, <a name="line.41"></a>
<FONT color="green">042</FONT>          TelemetryDefinitionType  type);<a name="line.42"></a>
<FONT color="green">043</FONT>      <a name="line.43"></a>
<FONT color="green">044</FONT>      /**<a name="line.44"></a>
<FONT color="green">045</FONT>       * Adds information about a definition.<a name="line.45"></a>
<FONT color="green">046</FONT>       * <a name="line.46"></a>
<FONT color="green">047</FONT>       * @param defInfo Information about the definition to be added.<a name="line.47"></a>
<FONT color="green">048</FONT>       * <a name="line.48"></a>
<FONT color="green">049</FONT>       * @throws TelemetryConfigurationException If there is duplicated definition.<a name="line.49"></a>
<FONT color="green">050</FONT>       */<a name="line.50"></a>
<FONT color="green">051</FONT>      public abstract void add(TelemetryDefinitionInfo defInfo) <a name="line.51"></a>
<FONT color="green">052</FONT>          throws TelemetryConfigurationException;<a name="line.52"></a>
<FONT color="green">053</FONT>      <a name="line.53"></a>
<FONT color="green">054</FONT>      /**<a name="line.54"></a>
<FONT color="green">055</FONT>       * Returns the list of TelemetryDefinitions associated with this manager.<a name="line.55"></a>
<FONT color="green">056</FONT>       * @return The list of telemetry definitions.<a name="line.56"></a>
<FONT color="green">057</FONT>       */<a name="line.57"></a>
<FONT color="green">058</FONT>      public abstract List&lt;TelemetryDefinition&gt; getDefinitions();<a name="line.58"></a>
<FONT color="green">059</FONT>    <a name="line.59"></a>
<FONT color="green">060</FONT>      /**<a name="line.60"></a>
<FONT color="green">061</FONT>       * Deletes a telemetry object definition. Does nothing if the definition does not exist.<a name="line.61"></a>
<FONT color="green">062</FONT>       * <a name="line.62"></a>
<FONT color="green">063</FONT>       * @param owner The owner of the definition.<a name="line.63"></a>
<FONT color="green">064</FONT>       * @param name The name of the definition.<a name="line.64"></a>
<FONT color="green">065</FONT>       * @param type The definition type.<a name="line.65"></a>
<FONT color="green">066</FONT>       */<a name="line.66"></a>
<FONT color="green">067</FONT>      public abstract void remove(User owner, String name, TelemetryDefinitionType  type);<a name="line.67"></a>
<FONT color="green">068</FONT>    }<a name="line.68"></a>




























































</PRE>
</BODY>
</HTML>
